Small changes to GitHub templates#1516
Conversation
There was a problem hiding this comment.
Pull request overview
Updates GitHub Issue Forms templates under .github/ISSUE_TEMPLATE to slightly refine how guidance text and example outputs are displayed when users file issues.
Changes:
- Adjusted the Feature Request placeholder YAML block style (
>-→>) for the summary prompt. - Updated Bug Report textarea
rendervalues fromconsoletoshellfor syntax highlighting consistency. - Removed trailing whitespace in blank lines within Bug Report placeholders.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .github/ISSUE_TEMPLATE/Feature_Request.yml | Tweaks placeholder block scalar style for the feature request summary field. |
| .github/ISSUE_TEMPLATE/Bug_Report.yml | Updates render language to shell and cleans up whitespace in example placeholders. |
michaeltlombardi
left a comment
michaeltlombardi
left a comment
There was a problem hiding this comment.
I'm surprised copilot recommended these changes. Except for the whitespace cleanup, the changes either don't affect the rendering (>- to >) or are semantically incorrect (console to shell).
| new feature would solve. Try formulating it in user story style | ||
| (if applicable). | ||
| placeholder: >- | ||
| placeholder: > |
There was a problem hiding this comment.
This change removes the trimming of trailing spacing. It doesn't make a large difference here, but I'm not sure why copilot suggested it.
| attributes: | ||
| label: Expected behavior | ||
| render: console | ||
| render: shell |
There was a problem hiding this comment.
I'm not sure we actually want this change - console is accurate (we're asking users to submit the text from a terminal session, including both commands and output).
Shell highlighting will give POSIX shell syntax highlighting for the commands but may look strange for output and will incorrectly highlight when the user's shell was PowerShell.
|
Let's just ignore these copilot suggestions |
PR Summary
Changed based on copilot suggestions